<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>navistore.backend.restkit.util.oauth2.Request : API documentation</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
    
    
  </head>
  <body>
    <h1 class="class">n.b.r.u.o.Request(<span title="dict">dict</span>) : class documentation</h1>
    <p>
      <span id="part">Part of <a href="navistore.html">navistore</a>.<a href="navistore.backend.html">backend</a>.<a href="navistore.backend.restkit.html">restkit</a>.<a href="navistore.backend.restkit.util.html">util</a>.<a href="navistore.backend.restkit.util.oauth2.html">oauth2</a></span>
      
      <a href="classIndex.html#navistore.backend.restkit.util.oauth2.Request">View In Hierarchy</a>
    </p>
    <div>
      
    </div>
    <div>The parameters and information for an HTTP request, suitable for 
authorizing with OAuth credentials.</p>
<p>When a consumer wants to access a service's protected resources, it does
so using a signed HTTP request identifying itself (the consumer) with its 
key, and providing an access token authorized by the end user to access 
those resources.<table class="fieldTable"></table></div>

    
    
    <div id="splitTables">
      <table class="children sortable" id="id114">
  
  
<tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#__init__">__init__</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#url">url</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#method">method</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#get_nonoauth_parameters">get_nonoauth_parameters</a></td>
    <td><span>Get any non-OAuth parameters.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#to_header">to_header</a></td>
    <td><span>Serialize as a header for an HTTPAuth request.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#to_postdata">to_postdata</a></td>
    <td><span>Serialize as post data for a POST request.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#to_url">to_url</a></td>
    <td><span>Serialize as a URL for a GET request.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#get_parameter">get_parameter</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#get_normalized_parameters">get_normalized_parameters</a></td>
    <td><span>Return a string that contains the parameters that must be signed.</span></td>
  </tr><tr class="method">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#sign_request">sign_request</a></td>
    <td><span>Set the signature parameter to the result of sign.</span></td>
  </tr><tr class="classmethod">
    
    
    <td>Class Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#make_timestamp">make_timestamp</a></td>
    <td><span>Get seconds since epoch (UTC).</span></td>
  </tr><tr class="classmethod">
    
    
    <td>Class Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#make_nonce">make_nonce</a></td>
    <td><span>Generate pseudorandom number.</span></td>
  </tr><tr class="classmethod">
    
    
    <td>Class Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#from_request">from_request</a></td>
    <td><span>Combines multiple parameter sources.</span></td>
  </tr><tr class="classmethod">
    
    
    <td>Class Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#from_consumer_and_token">from_consumer_and_token</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="classmethod">
    
    
    <td>Class Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#from_token_and_callback">from_token_and_callback</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method private">
    
    
    <td>Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#_get_timestamp_nonce">_get_timestamp_nonce</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="staticmethod private">
    
    
    <td>Static Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#_split_header">_split_header</a></td>
    <td><span>Turn Authorization: header into parameters.</span></td>
  </tr><tr class="staticmethod private">
    
    
    <td>Static Method</td>
    <td><a href="navistore.backend.restkit.util.oauth2.Request.html#_split_url_string">_split_url_string</a></td>
    <td><span>Turn URL string into parameters.</span></td>
  </tr>
  
</table>
      
      
    </div>
    
    
    

    <div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.__init__">
    
  </a>
  <a name="__init__">
    
  </a>
  <div class="functionHeader">
    
    def
    __init__(self, method=HTTP_METHOD, url=None, parameters=None):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.url">
    
  </a>
  <a name="url">
    
  </a>
  <div class="functionHeader">
    @setter<br />
    def
    url(self, value):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.method">
    
  </a>
  <a name="method">
    
  </a>
  <div class="functionHeader">
    @setter<br />
    def
    method(self, value):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request._get_timestamp_nonce">
    
  </a>
  <a name="_get_timestamp_nonce">
    
  </a>
  <div class="functionHeader">
    
    def
    _get_timestamp_nonce(self):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.get_nonoauth_parameters">
    
  </a>
  <a name="get_nonoauth_parameters">
    
  </a>
  <div class="functionHeader">
    
    def
    get_nonoauth_parameters(self):
    
  </div>
  <div class="functionBody">
    
    <div>Get any non-OAuth parameters.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.to_header">
    
  </a>
  <a name="to_header">
    
  </a>
  <div class="functionHeader">
    
    def
    to_header(self, realm=''):
    
  </div>
  <div class="functionBody">
    
    <div>Serialize as a header for an HTTPAuth request.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.to_postdata">
    
  </a>
  <a name="to_postdata">
    
  </a>
  <div class="functionHeader">
    
    def
    to_postdata(self):
    
  </div>
  <div class="functionBody">
    
    <div>Serialize as post data for a POST request.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.to_url">
    
  </a>
  <a name="to_url">
    
  </a>
  <div class="functionHeader">
    
    def
    to_url(self):
    
  </div>
  <div class="functionBody">
    
    <div>Serialize as a URL for a GET request.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.get_parameter">
    
  </a>
  <a name="get_parameter">
    
  </a>
  <div class="functionHeader">
    
    def
    get_parameter(self, parameter):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.get_normalized_parameters">
    
  </a>
  <a name="get_normalized_parameters">
    
  </a>
  <div class="functionHeader">
    
    def
    get_normalized_parameters(self):
    
  </div>
  <div class="functionBody">
    
    <div>Return a string that contains the parameters that must be signed.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.sign_request">
    
  </a>
  <a name="sign_request">
    
  </a>
  <div class="functionHeader">
    
    def
    sign_request(self, signature_method, consumer, token):
    
  </div>
  <div class="functionBody">
    
    <div>Set the signature parameter to the result of sign.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.make_timestamp">
    
  </a>
  <a name="make_timestamp">
    
  </a>
  <div class="functionHeader">
    @classmethod<br />
    def
    make_timestamp(cls):
    
  </div>
  <div class="functionBody">
    
    <div>Get seconds since epoch (UTC).<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.make_nonce">
    
  </a>
  <a name="make_nonce">
    
  </a>
  <div class="functionHeader">
    @classmethod<br />
    def
    make_nonce(cls):
    
  </div>
  <div class="functionBody">
    
    <div>Generate pseudorandom number.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.from_request">
    
  </a>
  <a name="from_request">
    
  </a>
  <div class="functionHeader">
    @classmethod<br />
    def
    from_request(cls, http_method, http_url, headers=None, parameters=None, query_string=None):
    
  </div>
  <div class="functionBody">
    
    <div>Combines multiple parameter sources.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.from_consumer_and_token">
    
  </a>
  <a name="from_consumer_and_token">
    
  </a>
  <div class="functionHeader">
    @classmethod<br />
    def
    from_consumer_and_token(cls, consumer, token=None, http_method=HTTP_METHOD, http_url=None, parameters=None):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request.from_token_and_callback">
    
  </a>
  <a name="from_token_and_callback">
    
  </a>
  <div class="functionHeader">
    @classmethod<br />
    def
    from_token_and_callback(cls, token, callback=None, http_method=HTTP_METHOD, http_url=None, parameters=None):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request._split_header">
    
  </a>
  <a name="_split_header">
    
  </a>
  <div class="functionHeader">
    @staticmethod<br />
    def
    _split_header(header):
    
  </div>
  <div class="functionBody">
    
    <div>Turn Authorization: header into parameters.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="navistore.backend.restkit.util.oauth2.Request._split_url_string">
    
  </a>
  <a name="_split_url_string">
    
  </a>
  <div class="functionHeader">
    @staticmethod<br />
    def
    _split_url_string(param_str):
    
  </div>
  <div class="functionBody">
    
    <div>Turn URL string into parameters.<table class="fieldTable"></table></div>
  </div>
</div>
    <address>
      <a href="index.html">API Documentation</a> for navistore, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2010-11-13 15:44:55.
    </address>
  </body>
</html>